Re-export main API from single module and remove Text.Parsing prefix per #78 #89
Conversation
thomashoneyman
added
the
type: breaking change
src/StringParser/Common.purs
Outdated
| @@ -1,6 +1,6 @@ | |||
| -- | This module defines the `Parser` type of string parsers, and its instances. | |||
|
|
|||
| module Text.Parsing.StringParser where | |||
| module StringParser.Common where | |||
There was a problem hiding this comment.
Maybe this should be StringParser.Parser since it specifically deals with the parser type?
There was a problem hiding this comment.
I named it Common because it contains more than just the Parser type, namely all the things that the CodeUnits parser and the CodePoints parser share but are not in Combinators.
But you have a lot more knowledge about naming conventions in the ecosystem, so should it be Parser instead? You tell me 😄
There was a problem hiding this comment.
I may be misunderstanding you; all I see in this file are the parser type and instances, plus runParser and unParser for running the parser, fail for setting an error message, and printParserError for unpacking the error message.
namely all the things that the CodeUnits parser and the CodePoints parser share but are not in Combinators.
I guess my question is — what is being shared here beyond the Parser type and helpers for its error messages? If it's nothing, then I think StringParser.Parser is a more informative module name. If it's more than that, then Common makes more sense.
There was a problem hiding this comment.
what is being shared here beyond the Parser type and helpers for its error messages?
That's pretty much it as you can see. So it's decided then :)
Fix #78
Checklist: